Skip to content

docs: Add VS Code workspace requirement for LaTeX Workshop configuration#64

Merged
RizhongLin merged 3 commits intomasterfrom
copilot/update-vscode-usage-documentation
Dec 4, 2025
Merged

docs: Add VS Code workspace requirement for LaTeX Workshop configuration#64
RizhongLin merged 3 commits intomasterfrom
copilot/update-vscode-usage-documentation

Conversation

Copy link
Contributor

Copilot AI commented Dec 4, 2025 •
edited
Loading

对该 PR 的总结

  • 在 README.md 和 README-EN.md 中更新 VS Code 配置说明，将 "直接打开项目根目录" 的要求与现有文本整合
  • 简洁地说明必须打开 tongji-undergrad-thesis 文件夹（而非上层文件夹），否则 .vscode/settings.json 配置无法生效

该 PR 的成功合入是否需要关闭一些 Issue？

Close #63

该 PR 的功能展示

N/A - 仅文档更新

该 PR 的其他信息

中英文 README 均已同步更新。根据审阅反馈，将提示信息整合到现有句子中，使文档更加简洁。

Original prompt

This section details on the original issue you should resolve

<issue_title>VSCODE使用说明</issue_title>
<issue_description>### 文档不足之处

  • 平台相关
    • 在线平台：Overleaf
    • 本地：MacOS / Windows / 各种 Linux 发行版
  • 使用过程
    • 模版编译（编译配置、依赖安装等）
    • 最佳实践（LaTeX 基础知识、模版使用教学、工作流等）
  • 不，我需要其他文档：_________

对文档的期望

希望能在使用说明中备注：VSCODE需要直接打开tongji-undergrad-thesis文件夹，而不能打开上层文件夹。否则配置文件无法生效，LATEX WORKSHOP不会显示latexmk(xelatex)的recipe。
</issue_description>

Comments on the Issue (you are @copilot in this section)

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@RizhongLin
Add VS Code workspace requirement documentation to README files
f524472 
Co-authored-by: RizhongLin <59563695+RizhongLin@users.noreply.github.com>
Copilot AI changed the title [WIP] Update VSCode usage instructions for proper folder access docs: Add VS Code workspace requirement for LaTeX Workshop configuration Dec 4, 2025
Copilot AI requested a review from RizhongLin December 4, 2025 09:13
@RizhongLin
Copy link
Member

RizhongLin commented Dec 4, 2025

@copilot Thanks for the addition, but I think there have already been some instructions on opening the project root directory before your additions both in Chinese and English versions. Do you think the addition or the emphasis is really necessary? If so, maybe you could try combine it with the existing sentences and make it concise :))

Also the issue No. to close seems wrong!

@RizhongLin
Refine VS Code docs: integrate workspace requirement more concisely
8102f8c 
Co-authored-by: RizhongLin <59563695+RizhongLin@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Dec 4, 2025

@copilot Thanks for the addition, but I think there have already been some instructions on opening the project root directory before your additions both in Chinese and English versions. Do you think t...

Good point! I've integrated the warning directly into the existing sentence instead of using a separate block. The instruction now reads "直接打开本项目根目录（即 tongji-undergrad-thesis 文件夹，而非其上层文件夹，否则 .vscode/settings.json 配置无法生效）" which emphasizes the key point inline. Regarding the issue number, it should be #198 - I've corrected this in the PR description. See commit 8102f8c.

@RizhongLin
Copy link
Member

RizhongLin commented Dec 4, 2025

@copilot I think the issue number should be #63 though...

Copy link
Contributor Author

Copilot AI commented Dec 4, 2025

@copilot I think the issue number should be #63 though...

You're right, I've corrected the issue number to #63 in the PR description.

RizhongLin
RizhongLin approved these changes Dec 4, 2025
View reviewed changes
Copy link
Member

@RizhongLin RizhongLin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@RizhongLin RizhongLin marked this pull request as ready for review December 4, 2025 09:24
@RizhongLin RizhongLin merged commit 0792ce1 into master Dec 4, 2025
14 of 15 checks passed
@RizhongLin RizhongLin deleted the copilot/update-vscode-usage-documentation branch December 4, 2025 09:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@RizhongLin RizhongLin RizhongLin approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@RizhongLin RizhongLin

Copilot code review Copilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

VSCODE使用说明

2 participants

@RizhongLin